Implement refscan-based real-time referential integrity checking on /metadata/json:validate
#835
+457
−62
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, we were checking it after inserting documents into _each_ specified collection, which made it so we would not know whether a referenced document would have been inserted into a later collection.
shreddd
reviewed
Jan 7, 2025
…time-referential-integrity-validation-in-runtime
|
The failing test involves the use of the string " For now, I'll update the referential integrity checking code to ignore incoming collections that are not lists. |
I don't know the use case here. It is a use case that the preexisting validation stages allowed for. I do not see any documentation about it.
aclum
approved these changes
Jan 14, 2025
eecavanna
deleted the
831-implement-refscan-based-real-time-referential-integrity-validation-in-runtime
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this branch, I implemented real-time referential integrity checking on the
/metadata/json:validateAPI endpoint. I also added automated tests that target thevalidate_jsonfunction.Details
Real-time referential integrity checking
Previously, the
validate_jsonfunction — the function that underlies the/metadata/json:validateAPI endpoint — did not validate inter-document references.On this branch, I updated that function so that it does validate inter-document references... if the caller "opts into" that by setting the newly-introduced
check_inter_document_references: bool = Falseparameter (to thevalidate_jsonfunction) toTrue.Based upon recent conversations with stakeholders, I "opted in" only the
/metadata/json:validateAPI endpoint to this new validation. I did not "opt in" the/metadata/json:submitAPI endpoint. That is so people can continue to run JSON-submitting code (i.e. API clients) that create referrer documents before creating the referree documents, a sequence of events that results in the database not having full referential integrity for a period of time.The core referential integrity checking is done by a function
import-ed from the refscan PyPI package. On this branch, I have addedrefscantorequirements/main.in(followed by running$ make update-deps).Tests targeting the
validate_jsonfunctionPreviously, there were no unit tests targeting the
validate_jsonfunction. I added some on this branch.In addition to targeting the original behavior of the function, which did not check inter-document references; the tests also target the new behavior of the function, where it checks inter-document references.
Related issue(s)
#831
Related subsystem(s)
docsdirectory)Testing
I tested these changes by implementing and running unit tests that target them.
Documentation
docsdirectory)Maintainability
study_id: str)# TODOor# FIXMEblackto format all the Python files I created/modified